home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / stdio / tmpnam.man < prev    next >
Text File  |  1989-10-03  |  3KB  |  70 lines
  1. ' Copyright 1989 Regents of the University of California
  2. ' Permission to use, copy, modify, and distribute this
  3. ' documentation for any purpose and without fee is hereby
  4. ' granted, provided that this notice appears in all copies.
  5. ' The University of California makes no representations about
  6. ' the suitability of this material for any purpose.  It is
  7. ' provided "as is" without express or implied warranty.
  8. ' 
  9. ' $Header: /sprite/src/lib/c/stdio/RCS/tmpnam.man,v 1.2 89/10/03 17:29:09 shirriff Exp $ SPRITE (Berkeley)
  10. ' 
  11. .so \*(]ltmac.sprite
  12. .HS tmpnam lib
  13. .BS
  14. .SH NAME
  15. tmpnam, tempnam \- Generate unique names for temporary files
  16. .SH SYNOPSIS
  17. .nf
  18. \fBinclude <stdio.h>
  19.  
  20. \fBchar *
  21. tmpnam(\fIs\fR)
  22.  
  23. \fBchar *
  24. tempnam(\fIdir\fR, \fIprefix\fR)
  25. .SH ARGUMENTS
  26. .AS char *prefix
  27. .AP char *s    in/out
  28. Place to store temporary file name.  If \fBNULL\fR, store name in local
  29. static storage that will be overwritten on next call to \fBtmpnam\fR.
  30. If not \fBNULL\fR, \fIs\fR must point to a buffer containing
  31. at least \fBL_tmpnam\fR bytes.
  32. .AP char *dir    in
  33. Directory in which to temporary file should reside.  If \fBNULL\fR,
  34. or if \fIdir\fR is not an accessible directory, defaults to \fBP_tmpdir\fR.
  35. .AP char *prefix in
  36. First few letters to use for name of temporary file.
  37. .BE
  38.  
  39. .SH DESCRIPTION
  40. .PP
  41. The procedures \fBtmpnam\fR and \fBtempnam\fR generate unique file
  42. names suitable for temporary files.  Each procedure returns a pointer
  43. to the name it generated, except that under some conditions (such
  44. as inability to allocate memory, for example) \fBtempnam\fR will
  45. fail to generate a file name.  When this happens, \fBtempnam\fR will
  46. return \fBNULL\fR.
  47. .PP
  48. \fBTmpnam\fR generates file names that refer to a standard directory
  49. defined by \fBP_tmpdir\fR (currently \fB/usr/tmp\fR).  Each time
  50. \fBtmpnam\fR is called it will return a different file name, which
  51. does not refer to any existing file.
  52. .PP
  53. \fBTempnam\fR is similar to \fBtmpnam\fR except that it provides
  54. more flexibility.  The \fIdir\fR argument may be used to specify
  55. a particular directory to which the generated name should refer.
  56. If this is not an accessible directory, then \fBP_tmpdir\fR will
  57. be used.  If this directory is not accessible either, then
  58. \fB/tmp\fR will be used as a last resort.  If the \fBTMPDIR\fR
  59. environment variable is defined and refers to an accessible
  60. directory, then it will override any of the above choices.
  61. .PP
  62. The \fIprefix\fR argument may be used to specify the first few letters
  63. of the last component of the path name generated by \fBtempnam\fR.
  64. \fBTempnam\fR dynamically allocates space for the name
  65. using \fBmalloc\fR.  It is the responsibility of the caller to
  66. release this storage by passing the returned string to \fBfree\fR
  67. when it is no longer needed.
  68. .SH KEYWORDS
  69. file name, temporary, unique
  70.